Component Formatting and Action Properties

Formatting

Text

The text displayed with the component. This is an optional field. If left blank, the Text field will default to display the component name. To clear the default Name from displaying, enter |SPACE|.

Tool Tip

The text displayed when hovering over the component.

Display Format

The formatting assigned to the component. See Component Display Format Properties.

Action

Bound Parameter

This is the name of the parameter the component will represent. The component will use the parameter to get its list of options. The selection will specify a value for the parameter when it is referenced elsewhere through piped variable naming. Click the ellipses Ellipses in a grey boxto open the Object Lookup dialog box. Either search the parameter name, or use the navigation tree to expand Workspace Maintenance Units to find the parameter.

NOTE:  Piped variable names are not available in this setting.

Apply Selected Value to Current Dashboard

When set to True, the Bound Parameter on the current dashboard will use the current updated value or use the value prior to update.  When set to False, the current dashboard will not be updated.

Save Action

Selection Changed Save Action

The save action that occurs when the component is used. You can choose from the following options:

  • No Action: When the Parameter components are changed, changes will not be saved.

  • Save Data for Components: This will save the data modified by the Dashboard components specified in the Selection Changed Save Arguments property.

  • Prompt to Save Data for Components: This will ask the user if the modified data should be saved or not for a defined list of Dashboard components.

  • Save Data for all Components: This will save all data modified by each of the Dashboard components assigned to the dashboard. These components do not have to be specified in the Selection Changed Save Arguments property.

  • Prompt to Save Data for All Components: This will ask the user if the modified data on any included dashboard component should be saved or not.

For Save Files properties specific to the Button component, see Button.

POV Action

Selection Changed POV Action

The changes that occur to a user's POV. You can choose from the following options:

  • No Action: When components are changed, no change is made to the user's POV.

  • Change POV: This setting will change the user’s POV to a specified POV when Parameter components are changed.

  • Change Workflow: This changes the user’s Workflow to a specified Workflow when Parameter components are changed.

  • Change POV and Workflow: This changes the Workflow and POV to a specified value when Parameter components are changed.

Selection Changed POV Arguments

Enter the arguments for the selected POV action. See the following examples: 

  • Change POV: Cube=Corporate, Entity=|!MyEntityParam!|, Scenario=Actual.

  • Change Workflow: Cube=Corporate, Entity=|!MyEntityParam!|, Scenario=Actual

  • Change Workflow: Enter a value for WFProfile, WFScenario, and/or WFTime. WFProfile=|!MyWFProfileParam!|, WFScenario=Actual, WFTime=2012M1

    NOTE: If the Selection Changed POV Action is set to No Action, no change will occur.

Server Task

Selection Changed Server Task

The server task that is completed. You can choose from the following options:

  • No Task: When Parameter components are changed, no server task is executed.

  • Execute Dashboard Extender Business Rule: Executes the assigned Business Rule when Parameter components are changed. For a long-running business rule, it can run on a specific server type, such as a Consolidation server type. You can choose from the following types:

    • Execute Dashboard Extender Business Rule (General Server)

    • Execute Dashboard Extender Business Rule (Stage Server)

    • Execute Dashboard Extender Business Rule (Consolidation Server)

    • Execute Dashboard Extender Business Rule (Data Management Server)

  • Execute Finance Custom Calculate Business Rule: Executes a single year custom calculation from a Finance business rule when Parameter components are changed.  The calculation is performed on the Cube View assigned to the dashboard Data Adapter, and it calculates time based on the Cube View Time member set in the Point of View. This is considered a partial calculation and does not store the calculated data or run the calculation during a consolidation.  Running a custom calculation from a dashboard will impact calculation status for the affected Data Unit even if the data does not change.  A calculated dimension member can call this business rule to do a full stored calculation. See About the Financial Model for an example of this calculation logic.

  • Execute Data Management Sequence: Executes the assigned Data Management Sequence when Parameter components are changed.

  • Calculate: Executes a Calculation when Parameter components are changed.

  • Force Calculate: Executes a Force Calculate when Parameter components are changed.

  • Calculate with Logging: Executes a Calculate with Logging when Parameter components are changed.

  • Force Calculate with Logging: Executes a Force Calculate with Logging when Parameter components are changed.

  • Translate: Executes Translate when Parameter components are changed.

  • Force Translate: Executes Force Translate when Parameter components are changed.

  • Translate with Logging: Executes Translate with Logging when Parameter components are changed.

  • Force Translate with Logging: Executes Force Translate with Logging when Parameter components are changed.

  • Consolidate: Executes Consolidate when Parameter components are changed.

  • Force Consolidate: Executes Force Consolidate when Parameter components are changed.

  • Consolidate with Logging: Executes Consolidate with Logging when Parameter components are changed.

  • Force Consolidate with Logging: Executes Force Consolidate with Logging when Parameter components are changed.

For more details on these calculation types, see Data Management.

Selection Changed Server Task Arguments

Enter the components to which the Server Task action applies. See the following examples:

  • Dashboard Extender Business Rule: {Business Rule Name}{Function Name}{Optional Name-Value Pairs}.

  • Finance Custom Calculate Business Rule: {Business Rule Name}{Function Name}{Optional Name-Value Pairs}.

    NOTE: Name-Value Pairs can have settings for Cube, Parent, and any Dimension Type. They can also have a setting for any Time Member Filter, including CurrentPeriod, AllPriorInYearInclusive, or AllInYear. They can have any other Name-Value Pair for use by the Business Rule since they are passed into the rule using the CustomCalculateArgs object.

  • Data Management Sequence Example: {Sequence Name}{Optional Name-Value Pairs}.

  • Calculation, Translation, or Consolidation: {Data Unit Member Script} {E#|!EntityParam!|:C#Local:S#Actual:T#|!TimeParam!|}.

User Interface Action

Selection Changed User Interface Action

The user interface action that is completed. You can choose from the following options:

  • No Action: When Parameter components are changed, no user interface action is executed.

  • Redraw: This repaints the screen without making a connection to the database acquiring updated data.

  • Refresh: This refreshes the dashboard specified in the Dashboards to Redraw property, which makes a connection back to the database acquiring all new data.

  • Close Dialog: This closes the dialog box after performing a specified action in a dashboard.

  • Close Dialog As OK: This closes the dialog box after the user clicks OK.

    NOTE: The refresh of the parent dashboard is based on performing a specified action setup in a dashboard. For example, if a dashboard is set to Open Dialog With No Buttons and Refresh, the Close Dialog As OK will refresh the parent dashboard and run the UI action.

  • Close Dialog As Cancel: This closes the dialog box after the user clicks Cancel.

  • Close All Dialogs: This closes all open dialog boxes after performing a specified action in a dashboard.

  • Open Dialog: Opens a dashboard in a modal window.

  • Open Dialog with No Buttons: Performs an Open Dialog action and does not display the Close button.

  • Open Dialog with No Buttons and Redraw: Performs an Open Dialog and enables the user to apply changes and Redraw without displaying the Close button.

  • Open Dialog with No Buttons and Refresh: Performs both an Open Dialog and Refresh action without displaying the Close button.

  • Open Dialog and Redraw: Performs both an Open Dialog and Redraw action.

  • Open Dialog and Refresh: Performs both an Open Dialog and Refresh action.

  • Open Dialog, Apply Changes, and Redraw: Performs an Open Dialog and enables the user to apply changes and Redraw.

  • Open Dialog, Apply Changes, and Refresh: Performs an Open Dialog and enables the user to apply changes and Refresh.

  • Open Dialog, Apply Changes, and Redraw if OK: Performs an Open Dialog and enables the user to apply changes and Redraws once the user selects OK.

  • Open Dialog, Apply Changes, and Refresh if OK: Performs an Open Dialog and enables the user to apply changes and Refreshes once the user selects OK.

Dashboards to Redraw

A comma-separated list of embedded dashboards to redraw when the user changes the selection in the Parameter component.

Dashboards to Show

A comma-separated list of embedded dashboards to make visible when the user changes the selection in the Parameter component. This is typically used when multiple Parameter components are needed to collect settings to display an Embedded Content Dashboard.  After the last selection is made, that Parameter component will show the previously hidden Embedded Content Dashboard.

Dashboard to Hide

A comma-separated list of embedded dashboards to hide when Parameter components are changed.

Dashboards to Open in Dialog

A single dashboard to open in a modal window when the selected button is clicked.

Dialog Initial Parameter Values

Enter a comma-separated list of Name-Value Pairs to specify initial parameter values for the opened dialog box.

Example: DlgParam1=Value1, DlgParam2=[Value 2]

Dialog Input Parameter Map

Enter a comma-separated list of Name-Value Pairs to map parameter names used by this component’s dashboard to parameter names used by the opened dialog box.

Example: DlgParamName1 = This ParamName1, DlgParamName2=ThisParamName2. When the dialog box opens, the names of the parameters adjust to accommodate the dialog box.

Dialog Output Parameter Map

Enter a comma separated list of name-value pairs to map parameter names modified by the closed dialog to parameter names used by this component’s dashboard.

Example: ThisParamName1=DlgParamName1, ThisParamName2=DlgParamName2. When the dialog box closes, the names of the parameters adjust to accommodate this component’s dashboard.

Navigation Action

Selection Changed Navigation Action.

The navigation action that is completed. You can choose from the following options:

  • No Action: No navigation action is performed when Parameter components are changed.

  • Open File: When Parameter components are changed by a user, a new file opens. This is specified in the Selection Changed Navigation Arguments field.

  • Open Page: When Parameter components are changed by a user, a new page opens. This is specified in the Selection Changed Navigation Arguments field.

  • Open Web Site: When Parameter components are changed by the user, a website opens in a new browser. This is specified in the Selection Changed Navigation Arguments.

Selection Changed Navigation Arguments

Enter the arguments for the selected navigation. See the following examples:

  • Open Page: Specify the page name followed by a colon and the page type’s arguments separated by two ampersands: XFPage=Dashboard:NameofDashboard or XFPage=Workflow:NameofWorkflow.

  • Open Page in New Tab: An option in the Open Page Navigation type that allows dashboards launched from within a dashboard to launch into a new tab. Valid values are True and False: XFPage=Dashboard:MyDashboardName, OpenInNewXFPage=True.

  • Open File or Web Site: Specify the file source type, for example, Dashboard, Application, System, FileShare or URL, and specify the file name. Also use PinNavName=True/False or PinPOVName=True/False to open or close the Navigation or POV panes: FileSourceType=FileShare, FullFileName=Document/Public/NameofFile, OpeninXFPageIfPossible=False. 

    NOTE: Click the ellipses Ellipses in a grey boxto open the Object Lookup dialog box. Either search the argument string, or use the navigation tree to expand Workspace Maintenance Units. Once you select the argument string, click the OK button. This will enter the correct string in the field.